[Docs] Visualization documentation for SpiffWorkflow#2
Open
ivanmilevtues wants to merge 1 commit intorecursionpharma:mainfrom
Open
[Docs] Visualization documentation for SpiffWorkflow#2ivanmilevtues wants to merge 1 commit intorecursionpharma:mainfrom
ivanmilevtues wants to merge 1 commit intorecursionpharma:mainfrom
Conversation
Author
|
Hey, a quick update on our side, this week we released our diagram generaiton engine as an open-source project! If you are interested to see more on how the generation works you can do so at https://github.com/CodeBoarding/CodeBoarding |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR includes documentation enhanced with Mermaid diagrams that represent the codebase at a high level. You can view how they’re rendered here:
https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/SpiffWorkflow/on_boarding.md
The goal of these documents is to help people get up to speed quickly with the SpiffWorkflow codebase. Considering that SpiffWorkflow is a core component for other projects, I suppose a lot of people interact with it. The diagrams are designed to make codebases more approachable—especially for those who use code as a tool rather than as professional software engineers.
We believe this can be especially helpful for such projects (even though it is a fork) where many scientists and domain experts write or interact with code to support their work. We'd love to hear if diagrams like these could improve your onboarding or collaboration processes. What does your current onboarding look like? Do you think auto-generated, diagram-first documentation could play a role?
We’re generating these diagrams using a combination of static analysis and LLMs. We’ve also built a GitHub Action that you can add to any repository—it automatically updates the diagrams on every merge to main, release, or based on other heuristics.
We’d really love to connect and learn more about your needs—whether it's around onboarding, documentation, or helping people work more effectively with code. If you’re open to a quick chat, we’d be excited to explore how we can support your team.